Minor tidy-up.
authorEwan Mellor <ewan@xensource.com>
Sat, 27 Jan 2007 15:02:00 +0000 (15:02 +0000)
committerEwan Mellor <ewan@xensource.com>
Sat, 27 Jan 2007 15:02:00 +0000 (15:02 +0000)
Signed-off-by: Ewan Mellor <ewan@xensource.com>
docs/xen-api/xenapi-datamodel.tex

index 3d74a76302c209be7e9e6e8733545b6ea22be485..8b837a09ef94cd1ec35a7d66d303021f3e89bd29 100644 (file)
@@ -9642,13 +9642,13 @@ $\mathit{RO}_\mathit{run}$ &  {\tt VM} & VM ref & VM to which this console is at
 \hline
 \end{longtable}
 \subsection{Additional RPCs associated with class: console}
-\subsubsection{RPC name:~get\_record}
+\subsubsection{RPC name:~get\_uuid}
 
 {\bf Overview:} 
-Get the current state of the given console.
+Get the uuid field of the given console.
 
  \noindent {\bf Signature:} 
-\begin{verbatim} (console record) get_record (session_id s, console ref self)\end{verbatim}
+\begin{verbatim} string get_uuid (session_id s, console ref self)\end{verbatim}
 
 
 \noindent{\bf Arguments:}
@@ -9666,21 +9666,21 @@ Get the current state of the given console.
 
  \noindent {\bf Return Type:} 
 {\tt 
-console record
+string
 }
 
 
-all fields from the object
+value of the field
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
-\subsubsection{RPC name:~get\_by\_uuid}
+\subsubsection{RPC name:~get\_protocol}
 
 {\bf Overview:} 
-Get a reference to the object with the specified UUID.
+Get the protocol field of the given console.
 
  \noindent {\bf Signature:} 
-\begin{verbatim} (console ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
+\begin{verbatim} (console_protocol) get_protocol (session_id s, console ref self)\end{verbatim}
 
 
 \noindent{\bf Arguments:}
@@ -9690,7 +9690,7 @@ Get a reference to the object with the specified UUID.
 \begin{tabular}{|c|c|p{7cm}|}
  \hline
 {\bf type} & {\bf name} & {\bf description} \\ \hline
-{\tt string } & uuid & UUID of object to return \\ \hline 
+{\tt console ref } & self & reference to the object \\ \hline 
 
 \end{tabular}
 
@@ -9698,21 +9698,21 @@ Get a reference to the object with the specified UUID.
 
  \noindent {\bf Return Type:} 
 {\tt 
-console ref
+console\_protocol
 }
 
 
-reference to the object
+value of the field
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
-\subsubsection{RPC name:~create}
+\subsubsection{RPC name:~get\_uri}
 
 {\bf Overview:} 
-Create a new console instance, and return its handle.
+Get the uri field of the given console.
 
  \noindent {\bf Signature:} 
-\begin{verbatim} (console ref) create (session_id s, console record args)\end{verbatim}
+\begin{verbatim} string get_uri (session_id s, console ref self)\end{verbatim}
 
 
 \noindent{\bf Arguments:}
@@ -9722,7 +9722,7 @@ Create a new console instance, and return its handle.
 \begin{tabular}{|c|c|p{7cm}|}
  \hline
 {\bf type} & {\bf name} & {\bf description} \\ \hline
-{\tt console record } & args & All constructor arguments \\ \hline 
+{\tt console ref } & self & reference to the object \\ \hline 
 
 \end{tabular}
 
@@ -9730,21 +9730,21 @@ Create a new console instance, and return its handle.
 
  \noindent {\bf Return Type:} 
 {\tt 
-console ref
+string
 }
 
 
-reference to the newly created object
+value of the field
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
-\subsubsection{RPC name:~destroy}
+\subsubsection{RPC name:~get\_VM}
 
 {\bf Overview:} 
-Destroy the specified console instance.
+Get the VM field of the given console.
 
  \noindent {\bf Signature:} 
-\begin{verbatim} void destroy (session_id s, console ref self)\end{verbatim}
+\begin{verbatim} (VM ref) get_VM (session_id s, console ref self)\end{verbatim}
 
 
 \noindent{\bf Arguments:}
@@ -9762,21 +9762,21 @@ Destroy the specified console instance.
 
  \noindent {\bf Return Type:} 
 {\tt 
-void
+VM ref
 }
 
 
-
+value of the field
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
-\subsubsection{RPC name:~get\_uuid}
+\subsubsection{RPC name:~create}
 
 {\bf Overview:} 
-Get the uuid field of the given console.
+Create a new console instance, and return its handle.
 
  \noindent {\bf Signature:} 
-\begin{verbatim} string get_uuid (session_id s, console ref self)\end{verbatim}
+\begin{verbatim} (console ref) create (session_id s, console record args)\end{verbatim}
 
 
 \noindent{\bf Arguments:}
@@ -9786,7 +9786,7 @@ Get the uuid field of the given console.
 \begin{tabular}{|c|c|p{7cm}|}
  \hline
 {\bf type} & {\bf name} & {\bf description} \\ \hline
-{\tt console ref } & self & reference to the object \\ \hline 
+{\tt console record } & args & All constructor arguments \\ \hline 
 
 \end{tabular}
 
@@ -9794,21 +9794,21 @@ Get the uuid field of the given console.
 
  \noindent {\bf Return Type:} 
 {\tt 
-string
+console ref
 }
 
 
-value of the field
+reference to the newly created object
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
-\subsubsection{RPC name:~get\_protocol}
+\subsubsection{RPC name:~destroy}
 
 {\bf Overview:} 
-Get the protocol field of the given console.
+Destroy the specified console instance.
 
  \noindent {\bf Signature:} 
-\begin{verbatim} (console_protocol) get_protocol (session_id s, console ref self)\end{verbatim}
+\begin{verbatim} void destroy (session_id s, console ref self)\end{verbatim}
 
 
 \noindent{\bf Arguments:}
@@ -9826,21 +9826,21 @@ Get the protocol field of the given console.
 
  \noindent {\bf Return Type:} 
 {\tt 
-console\_protocol
+void
 }
 
 
-value of the field
+
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
-\subsubsection{RPC name:~get\_uri}
+\subsubsection{RPC name:~get\_by\_uuid}
 
 {\bf Overview:} 
-Get the uri field of the given console.
+Get a reference to the console instance with the specified UUID.
 
  \noindent {\bf Signature:} 
-\begin{verbatim} string get_uri (session_id s, console ref self)\end{verbatim}
+\begin{verbatim} (console ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
 
 
 \noindent{\bf Arguments:}
@@ -9850,7 +9850,7 @@ Get the uri field of the given console.
 \begin{tabular}{|c|c|p{7cm}|}
  \hline
 {\bf type} & {\bf name} & {\bf description} \\ \hline
-{\tt console ref } & self & reference to the object \\ \hline 
+{\tt string } & uuid & UUID of object to return \\ \hline 
 
 \end{tabular}
 
@@ -9858,21 +9858,21 @@ Get the uri field of the given console.
 
  \noindent {\bf Return Type:} 
 {\tt 
-string
+console ref
 }
 
 
-value of the field
+reference to the object
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}
-\subsubsection{RPC name:~get\_VM}
+\subsubsection{RPC name:~get\_record}
 
 {\bf Overview:} 
-Get the VM field of the given console.
+Get a record containing the current state of the given console.
 
  \noindent {\bf Signature:} 
-\begin{verbatim} (VM ref) get_VM (session_id s, console ref self)\end{verbatim}
+\begin{verbatim} (console record) get_record (session_id s, console ref self)\end{verbatim}
 
 
 \noindent{\bf Arguments:}
@@ -9890,11 +9890,11 @@ Get the VM field of the given console.
 
  \noindent {\bf Return Type:} 
 {\tt 
-VM ref
+console record
 }
 
 
-value of the field
+all fields from the object
 \vspace{0.3cm}
 \vspace{0.3cm}
 \vspace{0.3cm}